Oauth2 TokenResult

The Oauth2 TokenResult schema contains data that represents successful access-token response as defined in RFC 6749 and extended in RFC 8693.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "access_token": "string",
    "token_type": "string",
    "expires_in": 0,
    "scope": "string",
    "refresh_token": "string",
    "issued_token_type": "string"
}

string As password As password

access_token

Required

The access token issued by the authorization server.

This property was added in vSphere API 8.0.3.0.

string

token_type

Required

A case-insensitive value specifying the method of using the access token issued.

This property was added in vSphere API 8.0.3.0.

integer As int64 As int64

expires_in

Optional

The validity lifetime, in seconds, of the token issued by the server.

This property was added in vSphere API 8.0.3.0.

missing or null if not applicable for issued token.

string

scope

Optional

Scope of the issued access token.

The value of the scope parameter is expressed as a list of space- delimited, case-sensitive strings. The strings are defined by the authorization server. If the value contains multiple space-delimited strings, their order does not matter, and each string adds an additional access range to the requested scope.

This property was added in vSphere API 8.0.3.0.

missing or null if the scope of the issued security token is identical to the scope requested by the client.

string As password As password

refresh_token

Optional

The refresh token, which can be used to obtain new access tokens.

This property was added in vSphere API 8.0.3.0.

missing or null if not applicable to the specific request.

string

issued_token_type

Optional

An identifier which indicates the type of the access token in the Oauth2 TokenResult.access_token property.

This property was added in vSphere API 8.0.3.0.

missing or null if not the result of a token-exchange invocation; otherwise, required.